<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>wdtps: xwdtps_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">wdtps
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xwdtps__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xwdtps_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the System Watchdog Timer Device (WdtPs) driver and hardware device using interrupt mode. </p>
<p>This test assumes that the RESET OUTPUT OF WDT IS NOT CONNECTED to the processor and the IRQ output is connected to an interrupt controller attached to the processor</p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.00a ecm/jz 01/15/10 First release
3.1     sg         08/20/18 Updated interrupt example to fix interrupt ID
                                                conflict issue
3.6     sb         06/27/23 Added support for system device-tree flow.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5880f1b662e70c26322b5070d232c134"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xwdtps__intr__example_8c.html#a5880f1b662e70c26322b5070d232c134">WdtPsIntrExample</a> (XScuGic *IntcInstancePtr, <a class="el" href="struct_x_wdt_ps.html">XWdtPs</a> *WdtInstancePtr, u16 WdtDeviceId, u16 WdtIntrId)</td></tr>
<tr class="memdesc:a5880f1b662e70c26322b5070d232c134"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function tests the functioning of the System WatchDog Timer driver in the Interrupt mode.  <a href="#a5880f1b662e70c26322b5070d232c134">More...</a><br/></td></tr>
<tr class="separator:a5880f1b662e70c26322b5070d232c134"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xwdtps__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the Wdt interrupt example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the Wdt interrupt example. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xwdtps__intr__example_8c.html#a5880f1b662e70c26322b5070d232c134">WdtPsIntrExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a5880f1b662e70c26322b5070d232c134"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int WdtPsIntrExample </td>
          <td>(</td>
          <td class="paramtype">XScuGic *&#160;</td>
          <td class="paramname"><em>IntcInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_wdt_ps.html">XWdtPs</a> *&#160;</td>
          <td class="paramname"><em>WdtInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>WdtDeviceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>WdtIntrId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function tests the functioning of the System WatchDog Timer driver in the Interrupt mode. </p>
<p>After one expiration of the timeout interval, an interrupt is generated and the WDT state bit is set to one in the status register.</p>
<p>This function assumes that the reset output of the Wdt device is not connected to the reset of the processor, otherwise, the timer will cause the processor to reset when it expires.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IntcInstancePtr</td><td>is a pointer to the instance of the XScuGic driver. </td></tr>
    <tr><td class="paramname">WdtInstancePtr</td><td>is a pointer to the instance of <a class="el" href="struct_x_wdt_ps.html" title="The XWdtPs driver instance data. ">XWdtPs</a> driver. </td></tr>
    <tr><td class="paramname">WdtDeviceId</td><td>is the Device ID of the <a class="el" href="struct_x_wdt_ps.html" title="The XWdtPs driver instance data. ">XWdtPs</a> device. </td></tr>
    <tr><td class="paramname">WdtIntrId</td><td>is the Interrupt Id of the <a class="el" href="struct_x_wdt_ps.html" title="The XWdtPs driver instance data. ">XWdtPs</a> device.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_wdt_ps___config.html#ab09dc2a13ed7882ec309278ebc43b16c">XWdtPs_Config::BaseAddress</a>, <a class="el" href="group__wdtps.html#ga9c5980e1118cff3e565fcc1f3b6e140a">XWDTPS_CCR_PSCALE_0008</a>, <a class="el" href="group__wdtps.html#gaf5315b5d46aba7c4d02b988740d44c66">XWdtPs_CfgInitialize()</a>, <a class="el" href="group__wdtps.html#ga4182ead880093d17d2b0962839821929">XWDTPS_CLK_PRESCALE</a>, <a class="el" href="group__wdtps.html#gac055573454d39a7fadf5cbd1ed19aea5">XWDTPS_COUNTER_RESET</a>, <a class="el" href="group__wdtps.html#ga0d6091a8ee48e49031cf0c8c92a87658">XWdtPs_DisableOutput()</a>, <a class="el" href="group__wdtps.html#ga8f98775051f9ea2cb0a47da8a75f555a">XWdtPs_EnableOutput()</a>, <a class="el" href="group__wdtps.html#ga1c3aaf158b04e2d1e77145d5b425c5d3">XWDTPS_IRQ_SIGNAL</a>, <a class="el" href="group__wdtps.html#ga5ad51ea203fc3eb20ecd848117c2f930">XWdtPs_IsWdtExpired</a>, <a class="el" href="group__wdtps.html#ga4b447b33afe318703da0f9f96849ee41">XWdtPs_LookupConfig()</a>, <a class="el" href="group__wdtps.html#gad0b2439fb19478f1b1c1d14b76cd15cc">XWDTPS_RESET_SIGNAL</a>, <a class="el" href="group__wdtps.html#ga89baace72a7b8abe477a8cfed4606a08">XWdtPs_RestartWdt</a>, <a class="el" href="group__wdtps.html#ga173e89798890bf73fd20f5cdadf113b5">XWdtPs_SelfTest()</a>, <a class="el" href="group__wdtps.html#ga64f2de6079bde6e9b8c495401a555a64">XWdtPs_SetControlValue()</a>, <a class="el" href="group__wdtps.html#ga2ac689cec0d17cc916c509285635135b">XWdtPs_Start()</a>, and <a class="el" href="group__wdtps.html#ga4a8899689039c676ab3ad7ff80c9c750">XWdtPs_Stop()</a>.</p>

<p>Referenced by <a class="el" href="xwdtps__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
